ENTITY-MIB DEFINITIONS::=BEGINIMPORTSMODULE-IDENTITY,OBJECT-TYPE,mib-2,NOTIFICATION-TYPEFROM SNMPv2-SMI
TDomain,TAddress,DisplayString,TEXTUAL-CONVENTION,AutonomousType,RowPointer,TimeStampFROM SNMPv2-TC
MODULE-COMPLIANCE,OBJECT-GROUPFROM SNMPv2-CONF;entityMIB MODULE-IDENTITYLAST-UPDATED"9605160000Z"
ORGANIZATION"IETF ENTMIB Working Group"CONTACT-INFO" WG E-mail: entmib@cisco.com
Subscribe: majordomo@cisco.com
msg body: subscribe entmib
Keith McCloghrie
ENTMIB Working Group Chair
Cisco Systems Inc.
170 West Tasman Drive
San Jose, CA 95134
408-526-5260
kzm@cisco.com
Andy Bierman
ENTMIB Working Group Editor
Cisco Systems Inc.
170 West Tasman Drive
San Jose, CA 95134
408-527-3711
abierman@cisco.com"DESCRIPTION"The MIB module for representing multiple logical
entities supported by a single SNMP agent."::={ mib-2 47}entityMIBObjects OBJECTIDENTIFIER::={ entityMIB 1}
-- MIB contains four groupsentityPhysical OBJECTIDENTIFIER::={ entityMIBObjects 1}entityLogical OBJECTIDENTIFIER::={ entityMIBObjects 2}entityMapping OBJECTIDENTIFIER::={ entityMIBObjects 3}entityGeneral OBJECTIDENTIFIER::={ entityMIBObjects 4}-- Textual ConventionsPhysicalIndex::=TEXTUAL-CONVENTIONSTATUScurrentDESCRIPTION"An arbitrary value which uniquely identifies the physical
entity. The value is a small positive integer; index values
for different physical entities are not necessarily
contiguous."SYNTAXINTEGER(1..2147483647)PhysicalClass::=TEXTUAL-CONVENTIONSTATUScurrentDESCRIPTION"An enumerated value which provides an indication of the
general hardware type of a particular physical entity."SYNTAXINTEGER{other(1),unknown(2),chassis(3),backplane(4),container(5),-- e.g. slot or daughter-card holderpowerSupply(6),
fan(7),sensor(8),module(9),-- e.g. plug-in card or daughter-cardport(10)}-- The Physical Entity TableentPhysicalTable OBJECT-TYPESYNTAXSEQUENCEOF EntPhysicalEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"This table contains one row per physical entity. There is
always at least one row for an 'overall' physical entity."::={ entityPhysical 1}entPhysicalEntry OBJECT-TYPESYNTAX EntPhysicalEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Information about a particular physical entity.
Each entry provides objects (entPhysicalDescr,
entPhysicalVendorType, and entPhysicalClass) to help an NMS
identify and characterize the entry, and objects
(entPhysicalContainedIn and entPhysicalParentRelPos) to help
an NMS relate the particular entry to other entries in this
table."INDEX{ entPhysicalIndex }::={ entPhysicalTable 1}
EntPhysicalEntry ::=SEQUENCE{
entPhysicalIndex PhysicalIndex,
entPhysicalDescr DisplayString,
entPhysicalVendorType AutonomousType,
entPhysicalContainedIn INTEGER,
entPhysicalClass PhysicalClass,
entPhysicalParentRelPos INTEGER,
entPhysicalName DisplayString}entPhysicalIndex OBJECT-TYPESYNTAXPhysicalIndexMAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"The index for this entry."::={ entPhysicalEntry 1}entPhysicalDescr OBJECT-TYPESYNTAXDisplayStringMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"A textual description of physical entity. This object
should contain a string which identifies the manufacturer's
name for the physical entity, and should be set to a
distinct value for each version or model of the physical
entity. "::={ entPhysicalEntry 2}
entPhysicalVendorType OBJECT-TYPESYNTAXAutonomousTypeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"An indication of the vendor-specific hardware type of the
physical entity. Note that this is different from the
definition of MIB-II's sysObjectID.
An agent should set this object to a enterprise-specific
registration identifier value indicating the specific
equipment type in detail. The associated instance of
entPhysicalClass is used to indicate the general type of
hardware device.
If no vendor-specific registration identifier exists for
this physical entity, or the value is unknown by this agent,
then the value { 0 0 } is returned."::={ entPhysicalEntry 3}entPhysicalContainedIn OBJECT-TYPESYNTAXINTEGER(0..2147483647)
MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of entPhysicalIndex for the physical entity which
'contains' this physical entity. A value of zero indicates
this physical entity is not contained in any other physical
entity. Note that the set of 'containment' relationships
define a strict hierarchy; that is, recursion is not
allowed."::={ entPhysicalEntry 4}entPhysicalClass OBJECT-TYPESYNTAXPhysicalClassMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"An indication of the general hardware type of the physical
entity.
An agent should set this object to the standard enumeration
value which most accurately indicates the general class of
the physical entity, or the primary class if there is more
than one.
If no appropriate standard registration identifier exists
for this physical entity, then the value 'other(1)' is
returned. If the value is unknown by this agent, then the
value 'unknown(2)' is returned."::={ entPhysicalEntry 5}entPhysicalParentRelPos OBJECT-TYPESYNTAXINTEGER(-1..2147483647)MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"An indication of the relative position of this 'child'
component among all its 'sibling' components. Sibling
components are defined as entPhysicalEntries which share the
same instance values of each of the entPhysicalContainedIn
and entPhysicalClass objects.
An NMS can use this object to identify the relative ordering
for all sibling components of a particular parent
(identified by the entPhysicalContainedIn instance in each
sibling entry).
This value should match any external labeling of the
physical component if possible. For example, for a module
labeled as 'card #3', entPhysicalParentRelPos should have
the value '3'.
If the physical position of this component does not match
any external numbering or clearly visible ordering, then
user documentation or other external reference material
should be used to determine the parent-relative position. If
this is not possible, then the the agent should assign a
consistent (but possibly arbitrary) ordering to a given set
of 'sibling' components, perhaps based on internal
representation of the components.
If the agent cannot determine the parent-relative position
for some reason, or if the associated value of
entPhysicalContainedIn is '0', then the value '-1' is
returned. Otherwise a non-negative integer is returned,
indicating the parent-relative position of this physical
entity.
Parent-relative ordering normally starts from '1' and
continues to 'N', where 'N' represents the highest
positioned child entity. However, if the physical entities
(e.g. slots) are labeled from a starting position of zero,
then the first sibling should be associated with a
entPhysicalParentRelPos value of '0'. Note that this
ordering may be sparse or dense, depending on agent
implementation.
The actual values returned are not globally meaningful, as
each 'parent' component may use different numbering
algorithms. The ordering is only meaningful among siblings
of the same parent component.
The agent should retain parent-relative position values
across reboots, either through algorithmic assignment or use
of non-volatile storage."::={ entPhysicalEntry 6}entPhysicalName OBJECT-TYPESYNTAXDisplayStringMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The textual name of the physical entity. The value of this
object should be the name of the component as assigned by
the local device and should be suitable for use in commands
entered at the device's `console'. This might be a text
name, such as `console' or a simple component number (e.g.
port or module number), such as `1', depending on the
physical component naming syntax of the device.
If there is no local name, or this object is otherwise not
applicable, then this object contains a zero-length string.
Note that the value of entPhysicalName for two physical
entities will be the same in the event that the console
interface does not distinguish between them, e.g., slot-1
and the card in slot-1."::={ entPhysicalEntry 7}-- The Logical Entity TableentLogicalTable OBJECT-TYPESYNTAXSEQUENCEOF EntLogicalEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"This table contains one row per logical entity. At least
one entry must exist."::={ entityLogical 1}
entLogicalEntry OBJECT-TYPESYNTAX EntLogicalEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Information about a particular logical entity. Entities
may be managed by this agent or other SNMP agents (possibly)
in the same chassis."INDEX{ entLogicalIndex }::={ entLogicalTable 1}
EntLogicalEntry ::=SEQUENCE{
entLogicalIndex INTEGER,
entLogicalDescr DisplayString,
entLogicalType AutonomousType,
entLogicalCommunity OCTETSTRING,
entLogicalTAddress TAddress,
entLogicalTDomain TDomain}entLogicalIndex OBJECT-TYPESYNTAXINTEGER(1..2147483647)MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"The value of this object uniquely identifies the logical
entity. The value is a small positive integer; index values
for different logical entities are are not necessarily
contiguous."::={ entLogicalEntry 1}entLogicalDescr OBJECT-TYPESYNTAXDisplayStringMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"A textual description of the logical entity. This object
should contain a string which identifies the manufacturer's
name for the logical entity, and should be set to a distinct
value for each version of the logical entity. "::={ entLogicalEntry 2}entLogicalType OBJECT-TYPESYNTAXAutonomousTypeMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"An indication of the type of logical entity. This will
typically be the OBJECT IDENTIFIER name of the node in the
SMI's naming hierarchy which represents the major MIB
module, or the majority of the MIB modules, supported by the
logical entity. For example:
a logical entity of a regular host/router -> mib-2
a logical entity of a 802.1d bridge -> dot1dBridge
a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt
If an appropriate node in the SMI's naming hierarchy cannot
be identified, the value 'mib-2' should be used."::={ entLogicalEntry 3}
entLogicalCommunity OBJECT-TYPESYNTAXOCTETSTRING(SIZE(1..255))MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"An SNMPv1 or SNMPv2C community-string which can be used to
access detailed management information for this logical
entity. The agent should allow read access with this
community string (to an appropriate subset of all managed
objects) and may also choose to return a community string
based on the privileges of the request used to read this
object. Note that an agent may choose to return a community
string with read-only privileges, even if this object is
accessed with a read-write community string. However, the
agent must take care not to return a community string which
allows more privileges than the community string used to
access this object.
A compliant SNMP agent may wish to conserve naming scopes by
representing multiple logical entities in a single 'main'
naming scope. This is possible when the logical entities
represented by the same value of entLogicalCommunity have no
object instances in common. For example, 'bridge1' and
'repeater1' may be part of the main naming scope, but at
least one additional community string is needed to represent
'bridge2' and 'repeater2'.
Logical entities 'bridge1' and 'repeater1' would be
represented by sysOREntries associated with the 'main'
naming scope.
For agents not accessible via SNMPv1 or SNMPv2C, the value
of this object is the empty-string."::={ entLogicalEntry 4}entLogicalTAddress OBJECT-TYPESYNTAXTAddressMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The transport service address by which the logical entity
receives network management traffic, formatted according to
the corresponding value of entLogicalTDomain.
For snmpUDPDomain, a TAddress is 6 octets long, the initial
4 octets containing the IP-address in network-byte order and
the last 2 containing the UDP port in network-byte order.
Consult 'Transport Mappings for Version 2 of the Simple
Network Management Protocol' (RFC 1906 [8]) for further
information on snmpUDPDomain."::={ entLogicalEntry 5}entLogicalTDomain OBJECT-TYPESYNTAXTDomainMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"Indicates the kind of transport service by which the
logical entity receives network management traffic.
Possible values for this object are presently found in the
Transport Mappings for SNMPv2 document (RFC 1906 [8])."::={ entLogicalEntry 6}entLPMappingTable OBJECT-TYPE
SYNTAXSEQUENCEOF EntLPMappingEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"This table contains zero or more rows of logical entity to
physical equipment associations. For each logical entity
known by this agent, there are zero or more mappings to the
physical resources which are used to realize that logical
entity.
An agent should limit the number and nature of entries in
this table such that only meaningful and non-redundant
information is returned. For example, in a system which
contains a single power supply, mappings between logical
entities and the power supply are not useful and should not
be included.
Also, only the most appropriate physical component which is
closest to the root of a particular containment tree should
be identified in an entLPMapping entry.
For example, suppose a bridge is realized on a particular
module, and all ports on that module are ports on this
bridge. A mapping between the bridge and the module would be
useful, but additional mappings between the bridge and each
of the ports on that module would be redundant (since the
entPhysicalContainedIn hierarchy can provide the same
information). If, on the other hand, more than one bridge
was utilizing ports on this module, then mappings between
each bridge and the ports it used would be appropriate.
Also, in the case of a single backplane repeater, a mapping
for the backplane to the single repeater entity is not
necessary."::={ entityMapping 1}entLPMappingEntry OBJECT-TYPESYNTAX EntLPMappingEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Information about a particular logical entity to physical
equipment association. Note that the nature of the
association is not specifically identified in this entry. It
is expected that sufficient information exists in the MIBs
used to manage a particular logical entity to infer how
physical component information is utilized."INDEX{ entLogicalIndex, entLPPhysicalIndex }::={ entLPMappingTable 1}
EntLPMappingEntry ::=SEQUENCE{
entLPPhysicalIndex PhysicalIndex}entLPPhysicalIndex OBJECT-TYPESYNTAXPhysicalIndexMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of this object identifies the index value of a
particular entPhysicalEntry associated with the indicated
entLogicalEntity."::={ entLPMappingEntry 1}-- logical entity/component to alias tableentAliasMappingTable OBJECT-TYPESYNTAXSEQUENCEOF EntAliasMappingEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"This table contains zero or more rows, representing
mappings of logical entity and physical component to
external MIB identifiers. Each physical port in the system
may be associated with a mapping to an external identifier,
which itself is associated with a particular logical
entity's naming scope. A 'wildcard' mechanism is provided to
indicate that an identifier is associated with more than one
logical entity."::={ entityMapping 2}entAliasMappingEntry OBJECT-TYPESYNTAX EntAliasMappingEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"Information about a particular physical equipment, logical
entity to external identifier binding. Each logical
entity/physical component pair may be associated with one
alias mapping. The logical entity index may also be used as
a 'wildcard' (refer to the entAliasLogicalIndexOrZero object
DESCRIPTION clause for details.)
Note that only entPhysicalIndex values which represent
physical ports (i.e. associated entPhysicalClass value is
'port(10)') are permitted to exist in this table."INDEX{ entPhysicalIndex, entAliasLogicalIndexOrZero }::={ entAliasMappingTable 1}
EntAliasMappingEntry ::=SEQUENCE{
entAliasLogicalIndexOrZero INTEGER,
entAliasMappingIdentifier RowPointer}entAliasLogicalIndexOrZero OBJECT-TYPESYNTAXINTEGER(0..2147483647)MAX-ACCESSnot-accessibleSTATUScurrent
DESCRIPTION"The value of this object uniquely identifies the logical
entity which defines the naming scope for the associated
instance of the 'entAliasMappingIdentifier' object.
If this object has a non-zero value, then it identifies the
logical entity named by the same value of entLogicalIndex.
If this object has a value of zero, then the mapping between
the physical component and the alias identifier for this
entAliasMapping entry is associated with all unspecified
logical entities. That is, a value of zero (the default
mapping) identifies any logical entity which does not have
an explicit entry in this table for a particular
entPhysicalIndex/entAliasMappingIdentifier pair.
For example, to indicate that a particular interface (e.g.
physical component 33) is identified by the same value of
ifIndex for all logical entities, the following instance
might exist:
entAliasMappingIdentifier.33.0 = ifIndex.5
In the event an entPhysicalEntry is associated differently
for some logical entities, additional entAliasMapping
entries may exist, e.g.:
entAliasMappingIdentifier.33.0 = ifIndex.6
entAliasMappingIdentifier.33.4 = ifIndex.1
entAliasMappingIdentifier.33.5 = ifIndex.1
entAliasMappingIdentifier.33.10 = ifIndex.12
Note that entries with non-zero entAliasLogicalIndexOrZero
index values have precedence over any zero-indexed entry. In
this example, all logical entities except 4, 5, and 10,
associate physical entity 33 with ifIndex.6."::={ entAliasMappingEntry 1}entAliasMappingIdentifier OBJECT-TYPESYNTAXRowPointerMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of this object identifies a particular conceptual
row associated with the indicated entPhysicalIndex and
entLogicalIndex pair.
Since only physical ports are modeled in this table, only
entries which represent interfaces or ports are allowed. If
an ifEntry exists on behalf of a particular physical port,
then this object should identify the associated 'ifEntry'.
For repeater ports, the appropriate row in the
'rptrPortGroupTable' should be identified instead.
For example, suppose a physical port was represented by
entPhysicalEntry.3, entLogicalEntry.15 existed for a
repeater, and entLogicalEntry.22 existed for a bridge. Then
there might be two related instances of
entAliasMappingIdentifier:
entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2
entAliasMappingIdentifier.3.22 == ifIndex.17
It is possible that other mappings (besides interfaces and
repeater ports) may be defined in the future, as required.
Bridge ports are identified by examining the Bridge MIB and
appropriate ifEntries associated with each 'dot1dBasePort',
and are thus not represented in this table."::={ entAliasMappingEntry 2}-- physical mapping tableentPhysicalContainsTable OBJECT-TYPESYNTAXSEQUENCEOF EntPhysicalContainsEntry
MAX-ACCESSnot-accessible
STATUScurrentDESCRIPTION"A table which exposes the container/containee relationships
between physical entities. This table provides equivalent
information found by constructing the virtual containment
tree for a given entPhysicalTable but in a more direct
format."::={ entityMapping 3}entPhysicalContainsEntry OBJECT-TYPESYNTAX EntPhysicalContainsEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"A single container/containee relationship."INDEX{ entPhysicalIndex, entPhysicalChildIndex }::={ entPhysicalContainsTable 1}
EntPhysicalContainsEntry ::=SEQUENCE{
entPhysicalChildIndex PhysicalIndex}entPhysicalChildIndex OBJECT-TYPESYNTAXPhysicalIndexMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of entPhysicalIndex for the contained physical
entity."::={ entPhysicalContainsEntry 1}-- last change time stamp for the whole MIBentLastChangeTime OBJECT-TYPESYNTAXTimeStampMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of sysUpTime at the time any of these events
occur:
* a conceptual row is created or deleted in any
of these tables:
- entPhysicalTable
- entLogicalTable
- entLPMappingTable
- entAliasMappingTable
- entPhysicalContainsTable
* any instance in the following list of objects
changes value:
- entPhysicalDescr
- entPhysicalVendorType
- entPhysicalContainedIn
- entPhysicalClass
- entPhysicalParentRelPos
- entPhysicalName
- entLogicalDescr
- entLogicalType
- entLogicalCommunity
- entLogicalTAddress
- entLogicalTDomain
- entAliasMappingIdentifier "::={ entityGeneral 1}-- Entity MIB Trap DefinitionsentityMIBTraps OBJECTIDENTIFIER::={ entityMIB 2}entityMIBTrapPrefix OBJECTIDENTIFIER::={ entityMIBTraps 0}entConfigChange NOTIFICATION-TYPE
STATUScurrentDESCRIPTION"An entConfigChange trap is sent when the value of
entLastChangeTime changes. It can be utilized by an NMS to
trigger logical/physical entity table maintenance polls.
An agent must not generate more than one entConfigChange
'trap-event' in a five second period, where a 'trap-event'
is the transmission of a single trap PDU to a list of trap
destinations. If additional configuration changes occur
within the five second 'throttling' period, then these
trap-events should be suppressed by the agent. An NMS should
periodically check the value of entLastChangeTime to detect
any missed entConfigChange trap-events, e.g. due to
throttling or transmission loss."::={ entityMIBTrapPrefix 1}-- conformance informationentityConformance OBJECTIDENTIFIER::={ entityMIB 3}entityCompliances OBJECTIDENTIFIER::={ entityConformance 1}
entityGroups OBJECTIDENTIFIER::={ entityConformance 2}-- compliance statementsentityCompliance MODULE-COMPLIANCESTATUScurrentDESCRIPTION"The compliance statement for SNMP entities which implement
the Entity MIB."MODULE-- this moduleMANDATORY-GROUPS{ entityPhysicalGroup,
entityLogicalGroup,
entityMappingGroup,
entityGeneralGroup,
entityNotificationsGroup }::={ entityCompliances 1}-- MIB groupings
entityPhysicalGroup OBJECT-GROUPOBJECTS{
entPhysicalDescr,
entPhysicalVendorType,
entPhysicalContainedIn,
entPhysicalClass,
entPhysicalParentRelPos,
entPhysicalName
}STATUScurrentDESCRIPTION"The collection of objects which are used to represent
physical system components, for which a single agent
provides management information."::={ entityGroups 1}entityLogicalGroup OBJECT-GROUPOBJECTS{
entLogicalDescr,
entLogicalType,
entLogicalCommunity,
entLogicalTAddress,
entLogicalTDomain
}STATUScurrent
DESCRIPTION"The collection of objects which are used to represent the
list of logical entities for which a single agent provides
management information."::={ entityGroups 2}entityMappingGroup OBJECT-GROUPOBJECTS{
entLPPhysicalIndex,
entAliasMappingIdentifier,
entPhysicalChildIndex
}STATUScurrentDESCRIPTION"The collection of objects which are used to represent the
associations between multiple logical entities, physical
components, interfaces, and port identifiers for which a
single agent provides management information."::={ entityGroups 3}entityGeneralGroup OBJECT-GROUPOBJECTS{
entLastChangeTime
}STATUScurrentDESCRIPTION"The collection of objects which are used to represent
general entity information for which a single agent provides
management information."::={ entityGroups 4}entityNotificationsGroup NOTIFICATION-GROUPNOTIFICATIONS{ entConfigChange }STATUScurrentDESCRIPTION"The collection of notifications used to indicate Entity MIB
data consistency and general status information."::={ entityGroups 5}END